Address Json Schema

In This Topic

Description

This object contains all information on the property address.

Required Fields:

county
state
zip

Preferred Fields

censustract

Overview

Address

This object contains all information on the property address.

Required Fields:

county
state
zip

Preferred Fields

censustract

censustract : string

Property ID in the national census data.

city : string

City where the property is located.

country : string

Country where the property is located.

county : string

County where the property is located.

This is used for countyFips. The best practice is to pass to alleviate issues when the same zip/state spans > 1 county (counties may have different loan limits).

Must pass state fips + county fips. Example, 25017 for Middlesex County, MA; 36103 for Suffolk, NY.

countyFips : string

CountyFips ID.

Populate this field if you are concerned that the state and zip area spans more than one county, in which case the API will only return the first county in the list.

countyName : string

Name of the county the property is located in.

defaultZipFipsComboOnMismatch : boolean

latitude : number

Property latitude.

longitude : number

Property longitude.

msa : string

province : string

The province where the property is located.

state : string

The state where the property is located.

Note: if only state and zip are passed, and the state and zip code area spans more than 1 county, the API will only return the first in the list. To avoid confusion, pass the countyFips.

stateFips : string

This field is DEFUNCT.

DO NOT USE.

street : string

The first line of the property street address.

Example: 10 Rose Court

streetCont : string

The second line of the property street address.

Example: Apt. C

zip : string

The property zip code.

Note: if only state and zip are passed, and the state and zip code area spans more than 1 county, the API will only return the first in the list. To avoid confusion, pass the countyFips.

zipExt : string

The four digit zip code area extension. The dash is not necessary.

Example: 2435

Do not enter in this format: -2435

Properties

Name	Description	Data Type
censustract	Property ID in the national census data.	string
city	City where the property is located.	string
country	Country where the property is located.	string
county	County where the property is located. This is used for countyFips. The best practice is to pass to alleviate issues when the same zip/state spans > 1 county (counties may have different loan limits). Must pass state fips + county fips. Example, 25017 for Middlesex County, MA; 36103 for Suffolk, NY.	string
countyFips	CountyFips ID. Populate this field if you are concerned that the `state` and `zip` area spans more than one county, in which case the API will only return the first county in the list.	string
countyName	Name of the county the property is located in.	string
defaultZipFipsComboOnMismatch		boolean
latitude	Property latitude.	number
longitude	Property longitude.	number
msa		string
province	The province where the property is located.	string
state	The state where the property is located. Note: if only `state` and `zip` are passed, and the state and zip code area spans more than 1 county, the API will only return the first in the list. To avoid confusion, pass the `countyFips`.	string
stateFips	This field is DEFUNCT. DO NOT USE.	string
street	The first line of the property street address. Example: 10 Rose Court	string
streetCont	The second line of the property street address. Example: Apt. C	string
zip	The property zip code. Note: if only `state` and `zip` are passed, and the state and zip code area spans more than 1 county, the API will only return the first in the list. To avoid confusion, pass the `countyFips`.	string
zipExt	The four digit zip code area extension. The dash is not necessary. Example: 2435 Do not enter in this format: -2435	string